<?php
////////////////////////////////////////////////////////////////////////////
//                                                                        //
// NOTICE OF COPYRIGHT                                                    //
//                                                                        //
// Dean`s Office for Moodle                                               //
// Электронный деканат                                                    //
// <http://deansoffice.ru/>                                               //
//                                                                        //
// Copyright (C) 2008-2999  Alex Djachenko (Алексей Дьяченко)             //
// alex-pub@my-site.ru                                                    //
// This program is free software: you can redistribute it and/or modify   //
// it under the terms of the GNU General Public License as published by   //
// the Free Software Foundation, either version 3 of the Licensen.        //
//                                                                        //
// This program is distributed in the hope that it will be useful,        //
// but WITHOUT ANY WARRANTY; without even the implied warranty of         //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          //
// GNU General Public License for more details.                           //
//                                                                        //
// You should have received a copy of the GNU General Public License      //
// along with this program.  If not, see <http://www.gnu.org/licenses/>.  //
//                                                                        //
////////////////////////////////////////////////////////////////////////////


/** Плагин для складирования тестов
 * 
 */
class dof_im_atest implements dof_plugin_im
{
    /**
     * @var dof_control
     */
    protected $dof;
    // **********************************************
    // Методы, предусмотренные интерфейсом plugin
    // **********************************************
    /** Метод, реализующий инсталяцию плагина в систему
     * Создает или модифицирует существующие таблицы в БД
     * и заполняет их начальными значениями
     * @return boolean
     * Может надо возвращать массив с названиями таблиц и результатами их создания?
     * чтобы потом можно было распечатать сообщения о результатах обновления
     * @access public
     */
    public function install()
    {
        return true;
    }
    /** Метод, реализующий обновление плагина в системе
     * Создает или модифицирует существующие таблицы в БД
     * @param string $old_version - версия установленного в системе плагина
     * @return boolean
     * Может надо возвращать массив с названиями таблиц и результатами их создания/изменения?
     * чтобы потом можно было распечатать сообщения о результатах обновления
     * @access public
     */
    public function upgrade($oldversion)
    {
        return true;
    }
    /** Возвращает версию установленного плагина
     * @return string
     * @access public
     */
    public function version()
    {
        return 2012052900;
    }
    /** Возвращает версии интерфейса Деканата, 
     * с которыми этот плагин может работать
     * @return string
     * @access public
     */
    public function compat_dof()
    {
        return 'aquarium';
    }

    /** Возвращает версии стандарта плагина этого типа, 
     * которым этот плагин соответствует
     * @return string
     * @access public
     */
    public function compat()
    {
        return 'angelfish';
    }
    
    /** Возвращает тип плагина
     * @return string 
     * @access public
     */
    public function type()
    {
        return 'im';
    }
    /** Возвращает короткое имя плагина
     * Оно должно быть уникально среди плагинов этого типа
     * @return string
     * @access public
     */
    public function code()
    {
        return 'exampleim';
    }
    /** Возвращает список плагинов, 
     * без которых этот плагин работать не может
     * @return array
     * @access public
     */
    public function need_plugins()
    {
        return array('modlib'=>array('nvg'=>2008060300));
    }
    /** Список обрабатываемых плагином событий 
     * @return array - array(array('plugintype'=>..,'plugincode'=>..,'eventcode'=>..),...)
     * @access public
     */
    public function list_catch_events()
    {
       return array(array('plugintype' => 'storage', 'plugincode' => 'config', 'eventcode' => 'plugin_install'),
                    array('plugintype' => 'storage', 'plugincode' => 'config', 'eventcode' => 'plugin_upgrade'),
                    array('plugintype' => 'storage', 'plugincode' => 'config', 'eventcode' => 'plugin_uninstall')); 
    }
    /** Требуется ли запуск cron в плагине
     * @return bool
     * @access public
     */
    public function is_cron()
    {
		// Этому плагину не нужен крон
		return false;
    }
    
    /** Проверяет полномочия на совершение действий
     * @param string $do - идентификатор действия, которое должно быть совершено
     * @param int $id_obj - идентификатор экземпляра объекта, 
     * по отношению к которому это действие должно быть применено
     * @param int $user_id - идентификатор пользователя, полномочия которого проверяются
     * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
     * false - доступ запрещен
     * @access public
     */
    public function is_access($do, $objid = NULL, $userid = NULL)
    {
        // Используем функционал из $DOFFICE
        return $this->dof->is_access($do, NULL, $userid);
    }
    /** Требует наличия полномочия на совершение действий
     * @param string $do - идентификатор действия, которое должно быть совершено
     * @param int $id_obj - идентификатор экземпляра объекта, 
     * по отношению к которому это действие должно быть применено
     * @param int $user_id - идентификатор пользователя, полномочия которого проверяются
     * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
     * false - доступ запрещен
     * @access public
     */
    public function require_access($do, $objid = NULL, $userid = NULL)
    {
        // Используем функционал из $DOFFICE
        return $this->dof->require_access($do, NULL, $userid);
    }
    /** Обработать событие
     * @param string $gentype - тип модуля, сгенерировавшего событие
     * @param string $gencode - код модуля, сгенерировавшего событие
     * @param string $eventcode - код задания
     * @param int $intvar - дополнительный параметр 
     * @param mixed $mixedvar - дополнительные параметры
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function catch_event($gentype,$gencode,$eventcode,$intvar,$mixedvar)
    {
        //print_object($intvar);
        //print_object($mixedvar);
        return true;
    }
    /** Запустить обработку периодических процессов
     * @param int $loan - нагрузка (1 - только срочные, 2 - нормальный режим, 3 - ресурсоемкие операции)
     * @param int $messages - количество отображаемых сообщений (0 - не выводить,1 - статистика,
     *  2 - индикатор, 3 - детальная диагностика)
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function cron($loan,$messages)
    {
        return true;
    }
    /** Обработать задание, отложенное ранее в связи с его длительностью
     * @param string $code - код задания
     * @param int $intvar - дополнительный параметр 
     * @param mixed $mixedvar - дополнительные параметры
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function todo($code,$intvar,$mixedvar)
    {
        return true;
    }
    /** Конструктор
     * @param dof_control $dof - идентификатор действия, которое должно быть совершено
     * @access public
     */
    public function __construct($dof)
    {
        $this->dof = $dof;
    }
    // **********************************************
    // Методы, предусмотренные интерфейсом im
    // **********************************************
    /** Возвращает содержимое блока
     * @param string $name - название набора текстов для отображания
     * @param int $id - id текста в наборе
     * @return string - html-код названия блока
     */
    function get_block($name, $id = 1)
    {
		switch ($name)
		{
       		case 'main': 
       		 	return '<a href="'.$this->dof->url_im('exampleim').'">'
							.$this->dof->get_string('title', 'exampleim').'</a>';
			break;	
			case 'test':
				return "Это тестовый блок N{$id}";
			break;
       		default:
				return "Это блок {$name} N{$id}";
			break;
		}
    }
    /** Возвращает содержимое секции
     * @param string $name - название набора текстов для отображания
     * @param int $id - id текста в наборе
     * @return string  - html-код названия секции
     */
    function get_section($name, $id = 1)
    {
    	switch ($name)
		{
       		case 'test':
				return "Это тестовая секция N{$id}";
			break;
       		default:
				return "";
			break;
		}
    }
     /** Возвращает текст для отображения в блоке dof
     * @return string  - html-код для отображения
     */
    public function get_blocknotes()
    {
		return "";
    }
    
    /** Получить URL к собственным файлам плагина
     * @param string $adds[optional] - фрагмент пути внутри папки плагина
     *                                 начинается с /. Например '/index.php'
     * @param array $vars[optional] - параметры, передаваемые вместе с url
     * @return string - путь к папке с плагином 
     * @access public
     */
    public function url($adds='', $vars=array())
    {
        return $this->dof->url_im($this->code(), $adds, $vars);
    }
    
    /** Тестирование сохранения данных при inline-редактировании (плагин modlib/widgets)
     * @param string $querytype - уникальное имя запроса сохранения внутри плагина. Как правило имя 
     *                            сохраняемого поля
     * @param int    $objectid - id объекта, данные которого редактируются
     * @param object $data -  данные для сохранения (обычно - новое значение поля)
     * 
     * @return string - новое значение элемента или строка с html-кодом ошибки
     */
    public function widgets_save_field($querytype, $objectid, $data)
    {
        switch ($querytype) 
        {
            case 'name':
                $obj = new object;
                $obj->id   = $objectid;
                $obj->name = $data;
                $this->dof->storage('examplest')->update($obj);
            break;
        }
        
        return $data;
    }
    /** Подгрузить значение поля перед inline-редактированием
     * @param string $fieldname - название поля объекта, которое будет подгружено
     * @param int    $objectid  - id редактируемого объекта
     * @param mixed  $data[optional] - дополнительные данные для запроса
     * 
     * @return string
     */
    public function widgets_load_field($fieldname, $objectid, $data=null)
    {
        return $this->dof->storage('examplest')->get_field($objectid, $fieldname);
    }
    
    /** Тестирование асинхронных запросов для получения данных
     * @param string $querytype - тип запроса
     * @param int $objectid 
     * @param array $data - данные пришедшие из json-запроса
     * 
     */
    public function widgets_field_variants_list($querytype, $objectid, $data)
    {
        if ( $querytype == 'test_ajaxselect' )
        {// тестируем элемент ajaxselect
        
            // получаем данные из json
            // print_r($data);
            // превращаем json строку в массив
            //$data = json_decode($data, true);
            // получаем из массива id родительского select-а
            $objectid = $data['parentvalue'];
            
            if ( $objectid == '1' )
            {
                return array(
                    1 => 'option1_1',
                    2 => 'option1_2',
                    3 => 'option1_3',
                    4 => 'option1_4',
                    5 => 'option1_5');
            }elseif ( $objectid == '2' )
            {
                return array(
                    1 => 'option2_1',
                    2 => 'option2_2',
                    3 => 'option2_3',
                    1024 => 'option2_4',
                    2048 => 'option2_5');
            }else
            {
                return array('0' => '...');
            }
        }
        
        // неизвестный тип запроса
        return array(0 => 'UNKNOWN QUERYTYPE');
    }
}

